using System;
using System.Collections;

namespace Evaluant.OPath.Expressions.Collections
{
	/// <summary>
	///     <para>
	///       A collection that stores <see cref="Constraint"/> objects.
	///    </para>
	/// </summary>
	/// <seealso cref="ConstraintCollection"/>
	[Serializable()]
    public class ConstraintCollection : CollectionBase 
	{
		
		/// <summary>
		///     <para>
		///       Initializes a new instance of <see cref="ConstraintCollection"/>.
		///    </para>
		/// </summary>
		public ConstraintCollection()
		{
		}
		
		/// <summary>
		///     <para>
		///       Initializes a new instance of <see cref="ConstraintCollection"/> based on another <see cref="ConstraintCollection"/>.
		///    </para>
		/// </summary>
		/// <param name="value">
		///       A <see cref="ConstraintCollection"/> from which the contents are copied
		/// </param>
		public ConstraintCollection(ConstraintCollection value)
		{
			this.AddRange(value);
		}
		
		/// <summary>
		///     <para>
		///       Initializes a new instance of <see cref="ConstraintCollection"/> containing any array of <see cref="Constraint"/> objects.
		///    </para>
		/// </summary>
		/// <param name="value">
		///       A array of <see cref="Constraint"/> objects with which to intialize the collection
		/// </param>
		public ConstraintCollection(Constraint[] value)
		{
			this.AddRange(value);
		}
		
		/// <summary>
		/// <para>Represents the entry at the specified index of the <see cref="Constraint"/>.</para>
		/// </summary>
		/// <param name="index"><para>The zero-based index of the entry to locate in the collection.</para></param>
		/// <value>
		///    <para> The entry at the specified index of the collection.</para>
		/// </value>
		/// <exception cref="System.ArgumentOutOfRangeException"><paramref name="index"/> is outside the valid range of indexes for the collection.</exception>
		public Constraint this[int index] 
		{
			get 
			{
				return ((Constraint)(List[index]));
			}
			set 
			{
				List[index] = value;
			}
		}
		
		/// <summary>
		///    <para>Adds a <see cref="Constraint"/> with the specified value to the 
		///    <see cref="ConstraintCollection"/> .</para>
		/// </summary>
		/// <param name="value">The <see cref="Constraint"/> to add.</param>
		/// <returns>
		///    <para>The index at which the new element was inserted.</para>
		/// </returns>
		/// <seealso cref="ConstraintCollection.AddRange"/>
		public int Add(Constraint value)
		{
			return List.Add(value);
		}
		
		/// <summary>
		/// <para>Copies the elements of an array to the end of the <see cref="ConstraintCollection"/>.</para>
		/// </summary>
		/// <param name="value">
		///    An array of type <see cref="Constraint"/> containing the objects to add to the collection.
		/// </param>
		/// <returns>
		///   <para>None.</para>
		/// </returns>
		/// <seealso cref="ConstraintCollection.Add"/>
		public void AddRange(Constraint[] value)
		{
			for (int i = 0; i < value.Length; i++) 
			{
				this.Add(value[i]);
			}
		}
		
		/// <summary>
		///     <para>
		///       Adds the contents of another <see cref="ConstraintCollection"/> to the end of the collection.
		///    </para>
		/// </summary>
		/// <param name="value">
		///    A <see cref="ConstraintCollection"/> containing the objects to add to the collection.
		/// </param>
		/// <returns>
		///   <para>None.</para>
		/// </returns>
		/// <seealso cref="ConstraintCollection.Add"/>
		public void AddRange(ConstraintCollection value)
		{
			for (int i = 0; i < value.Count; i++)
			{
				this.Add(value[i]);
			}
		}
		
		/// <summary>
		/// <para>Gets a value indicating whether the 
		///    <see cref="ConstraintCollection"/> contains the specified <see cref="Constraint"/>.</para>
		/// </summary>
		/// <param name="value">The <see cref="Constraint"/> to locate.</param>
		/// <returns>
		/// <para><see langword='true"/> if the <see cref="Constraint"/> is contained in the collection; 
		///   otherwise, <see langword='false"/>.</para>
		/// </returns>
		/// <seealso cref="ConstraintCollection.IndexOf"/>
		public bool Contains(Constraint value)
		{
			return List.Contains(value);
		}
		
		/// <summary>
		/// <para>Copies the <see cref="ConstraintCollection"/> values to a one-dimensional <see cref="System.Array"/> instance at the 
		///    specified index.</para>
		/// </summary>
		/// <param name="array"><para>The one-dimensional <see cref="System.Array"/> that is the destination of the values copied from <see cref="ConstraintCollection"/> .</para></param>
		/// <param name="index">The index in <paramref name="array"/> where copying begins.</param>
		/// <returns>
		///   <para>None.</para>
		/// </returns>
		/// <exception cref="System.ArgumentException"><para><paramref name="array"/> is multidimensional.</para> <para>-or-</para> <para>The number of elements in the <see cref="ConstraintCollection"/> is greater than the available space between <paramref name="arrayIndex"/> and the end of <paramref name="array"/>.</para></exception>
		/// <exception cref="System.ArgumentNullException"><paramref name="array"/> is <see langword='null"/>. </exception>
		/// <exception cref="System.ArgumentOutOfRangeException"><paramref name="index"/> is less than <paramref name="array"/>'s lowbound. </exception>
		/// <seealso cref="System.Array"/>
		public void CopyTo(Constraint[] array, int index)
		{
			List.CopyTo(array, index);
		}
		
		/// <summary>
		///    <para>Returns the index of a <see cref="Constraint"/> in 
		///       the <see cref="ConstraintCollection"/> .</para>
		/// </summary>
		/// <param name="value">The <see cref="Constraint"/> to locate.</param>
		/// <returns>
		/// <para>The index of the <see cref="Constraint"/> of <paramref name="value"/> in the 
		/// <see cref="ConstraintCollection"/>, if found; otherwise, -1.</para>
		/// </returns>
		/// <seealso cref="ConstraintCollection.Contains"/>
		public int IndexOf(Constraint value)
		{
			return List.IndexOf(value);
		}
		
		/// <summary>
		/// <para>Inserts a <see cref="Constraint"/> into the <see cref="ConstraintCollection"/> at the specified index.</para>
		/// </summary>
		/// <param name="index">The zero-based index where <paramref name="value"/> should be inserted.</param>
		/// <param name=" value">The <see cref="Constraint"/> to insert.</param>
		/// <returns><para>None.</para></returns>
		/// <seealso cref="ConstraintCollection.Add"/>
		public void Insert(int index, Constraint value)
		{
			List.Insert(index, value);
		}
		
		/// <summary>
		///    <para>Returns an enumerator that can iterate through 
		///       the <see cref="ConstraintCollection"/> .</para>
		/// </summary>
		/// <returns><para>None.</para></returns>
		/// <seealso cref="System.Collections.IEnumerator"/>
		internal new ConstraintEnumerator GetEnumerator()
		{
			return new ConstraintEnumerator(this);
		}
		
		/// <summary>
		///    <para> Removes a specific <see cref="Constraint"/> from the 
		///    <see cref="ConstraintCollection"/> .</para>
		/// </summary>
		/// <param name="value">The <see cref="Constraint"/> to remove from the <see cref="ConstraintCollection"/> .</param>
		/// <returns><para>None.</para></returns>
		/// <exception cref="System.ArgumentException"><paramref name="value"/> is not found in the Collection. </exception>
		public void Remove(Constraint value)
		{
			List.Remove(value);
		}
		
		internal class ConstraintEnumerator : IEnumerator
		{
			IEnumerator baseEnumerator;
			IEnumerable temp;
			
			public ConstraintEnumerator(ConstraintCollection mappings)
			{
				this.temp = ((IEnumerable)(mappings));
				this.baseEnumerator = temp.GetEnumerator();
			}
			
			public Constraint Current 
			{
				get 
				{
					return ((Constraint)(baseEnumerator.Current));
				}
			}
			
			object IEnumerator.Current 
			{
				get 
				{
					return baseEnumerator.Current;
				}
			}
			
			public bool MoveNext()
			{
				return baseEnumerator.MoveNext();
			}
			
			bool IEnumerator.MoveNext()
			{
				return baseEnumerator.MoveNext();
			}
			
			public void Reset()
			{
				baseEnumerator.Reset();
			}
			
			void IEnumerator.Reset()
			{
				baseEnumerator.Reset();
			}
		}
	}
}